home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / prgtools / programm.ing / ams__l~1.zoo / man / ams.man next >
Encoding:
Text File  |  1993-09-05  |  3.4 KB  |  98 lines
  1.                         ATARI MACHINE SPECIFIC LIBRARY
  2.  
  3.  
  4.  
  5. NAME
  6.      AMS - Atari Machine Specific library
  7.  
  8. DESCRIPTION
  9.      The AMS library is a collection of C++ classes and functions that
  10.      gives access to many features of the Atari computers sytems that
  11.      are not normally found in general-purpose C++ libraries.
  12.  
  13. MODULES
  14.  
  15.   DISPLAY
  16.      DoubleBuffer   - encapsulated double buffering support
  17.      Resolution     - support for the currently defined Atari resolutions
  18.      Screen         - support for Atari standard resolution screens
  19.  
  20.   DRAWING
  21.      BlockMap       - display of block-based graphics
  22.      FastCounter    - high speed incremental number display
  23.      SmallGraphics  - simply graphics functions
  24.      Sprite         - small, high-speed graphic objects
  25.        MobileSprite - a derived Sprite that moves by itself
  26.        EasySprite   - simplified sprite creation routines
  27.  
  28.   CONTROL
  29.      Joystick       - access to standard Atari joysticks
  30.      MousePosition  - access to the Atari mouse
  31.      ScanCode       - access to the Atari keyboard keys
  32.  
  33.   AUXILIARY
  34.      Oscillator     - cyclic value objects
  35.      Shape          - some shape classes
  36.      Termination    - taking control of hardware termination
  37.      fnameext       - filename manipulations
  38.  
  39. USAGE
  40.      To use AMS with the GNU C++ compiler (G++), add the path of the
  41.      AMS #include files to the GXXINC path.  Since the standard include
  42.      files have a "screen.h" (but a very pointless one), you should put
  43.      the AMS path BEFORE the standard ones, since "Screen.h" is normally
  44.      equivalent to "screen.h" on the Atari.
  45.  
  46.      Before the library can be used, it needs to be built (but it may
  47.      have already been built when you received it).  To build the library,
  48.      edit the makefile in the source directory to indicate you set-up
  49.      (it should be just a matter of setting $LIBRARY and $INC), then
  50.      type "make" in the source directory (this assumes you have a
  51.      default.mak consistent with the one that comes with AMS).  If you
  52.      do not use make (and you really should!), you can type:
  53.  
  54.          gcc -O2 *.cc
  55.          gnu-ar r ams.olb *.o
  56.          gnu-ar s ams.olb
  57.  
  58. EXAMPLES
  59.      See the "examples" directory for some simple programs that use AMS.
  60.  
  61. FILES
  62.      include/*.h      - Header files for AMS
  63.      src/*.cc         - C++ sources
  64.      man/*.man        - ASCII documentation
  65.      example/*        - Example programs
  66.      etc/default.mak  - make rules. (may need to set $MAKEFILES to this file)
  67.  
  68.      Degas picture formats - see Screen
  69.      CrackArt picture formats - see Screen
  70.      AMS Sprite format - see Sprite
  71.  
  72. SEE ALSO
  73.      FastCounter, MousePosition, Screen, BlockMap, fnameext, Oscillator,
  74.      Shape, Terminator, DoubleBuffer, Joystick, Resolution, SmallGraphics,
  75.      Timer, EasySprite, MobileSprite, ScanCode, Sprite.
  76.  
  77. DIAGNOSTICS
  78.      Since most of the functions in the AMS library are optimised for
  79.      speed, little parameter range checking is done.
  80.  
  81. BUGS
  82.      Bugs in AMS should be reported to warwick@cs.uq.oz.au
  83.  
  84. AUTHOR
  85.      Warwick Allison, 1992.
  86.      warwick@cs.uq.oz.au
  87.  
  88. COPYING
  89.      This functionality is part of the Atari Machine Specific Library,
  90.      and is Copyright 1992 by Warwick W. Allison.
  91.  
  92.      The Atari Machine Specific Library is free and protected under the
  93.      GNU Library General Public License.
  94.  
  95.      You are free to copy and modify these sources, provided you acknowledge
  96.      the origin by retaining this notice, and adhere to the conditions
  97.      described in the GNU LGPL.
  98.